-
Notifications
You must be signed in to change notification settings - Fork 374
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: Build doxygen documentation #816
base: main
Are you sure you want to change the base?
doc: Build doxygen documentation #816
Conversation
The Doxygen documentation is generated and uploaded with GitHub actions. Currently the code is not yet thoroughly documented.
68c30f3
to
eb9004d
Compare
Quality Gate passedIssues Measures |
# YES. | ||
# The default value is: system dependent. | ||
|
||
CASE_SENSE_NAMES = NO |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CI runs on Linux - should this be Yes or at least the default?
# The default value is: png. | ||
# This tag requires that the tag GENERATE_HTML is set to YES. | ||
|
||
HTML_FORMULA_FORMAT = png |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
HTML_FORMULA_FORMAT = png | |
HTML_FORMULA_FORMAT = svg |
# generate a warning when it encounters a \startuml command in this case and | ||
# will not generate output for the diagram. | ||
|
||
PLANTUML_JAR_PATH = |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would install platnuml via apt and enable support for it:
PLANTUML_JAR_PATH = | |
PLANTUML_JAR_PATH = /usr/share/plantuml/plantuml.jar |
@@ -221,6 +223,11 @@ function run_tests() { | |||
find "${REPO_ROOT_DIR}" -name \*.gcov -exec rm {} \; | |||
} | |||
|
|||
function run_doxygen() { | |||
mkdir -p build-wakaama/doxygen_out | |||
GIT_REVISION=$(git rev-parse @) WORKING_DIR=$(pwd) DOXYGEN_OUT_DIR=build-wakaama/doxygen_out \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would use either a dash, such as in build*-*wakaama:
GIT_REVISION=$(git rev-parse @) WORKING_DIR=$(pwd) DOXYGEN_OUT_DIR=build-wakaama/doxygen_out \ | |
GIT_REVISION=$(git rev-parse @) WORKING_DIR=$(pwd) DOXYGEN_OUT_DIR=build-wakaama/doxygen-out \ |
Or just leave out the _out
part:
GIT_REVISION=$(git rev-parse @) WORKING_DIR=$(pwd) DOXYGEN_OUT_DIR=build-wakaama/doxygen_out \ | |
GIT_REVISION=$(git rev-parse @) WORKING_DIR=$(pwd) DOXYGEN_OUT_DIR=build-wakaama/doxygen \ |
uses: actions/upload-artifact@v4 | ||
with: | ||
name: Doxygen documentation (HTML) | ||
path: build-wakaama/doxygen_out |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
path: build-wakaama/doxygen_out | |
path: build-wakaama/doxygen-out |
or
path: build-wakaama/doxygen_out | |
path: build-wakaama/doxygen |
(see other comment)
The Doxygen documentation is generated and uploaded with GitHub actions.
Currently the code is not yet thoroughly documented.